<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>mcdma: xmcdma_bd.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">mcdma
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xmcdma__bd_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">xmcdma_bd.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga4a9c2fa82ee0b3c7518b7b9125a447e0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga4a9c2fa82ee0b3c7518b7b9125a447e0">XMcdma_BdRead</a>(BaseAddress, Offset)&#160;&#160;&#160;(*(u32 *)(((UINTPTR)(void *)(BaseAddress)) + (u32)(Offset)))</td></tr>
<tr class="memdesc:ga4a9c2fa82ee0b3c7518b7b9125a447e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the given Buffer Descriptor word.  <a href="group__mcdma.html#ga4a9c2fa82ee0b3c7518b7b9125a447e0">More...</a><br/></td></tr>
<tr class="separator:ga4a9c2fa82ee0b3c7518b7b9125a447e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeea700e622c21664095d4015fdb3c182"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#gaeea700e622c21664095d4015fdb3c182">XMcdma_BdRead64</a>(BaseAddress, Offset)&#160;&#160;&#160;(*(u64 *)(((UINTPTR)(void *)(BaseAddress)) + (u32)(Offset)))</td></tr>
<tr class="memdesc:gaeea700e622c21664095d4015fdb3c182"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the given Buffer Descriptor word.  <a href="group__mcdma.html#gaeea700e622c21664095d4015fdb3c182">More...</a><br/></td></tr>
<tr class="separator:gaeea700e622c21664095d4015fdb3c182"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2e9ebef9ab28ab4e942a1c6415cebc08"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga2e9ebef9ab28ab4e942a1c6415cebc08">XMcdma_BdWrite</a>(BaseAddress, Offset, Data)&#160;&#160;&#160;(*(u32 *)((UINTPTR)(void *)(BaseAddress) + (u32)(Offset))) = (u32)(Data)</td></tr>
<tr class="memdesc:ga2e9ebef9ab28ab4e942a1c6415cebc08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write the given Buffer Descriptor word.  <a href="group__mcdma.html#ga2e9ebef9ab28ab4e942a1c6415cebc08">More...</a><br/></td></tr>
<tr class="separator:ga2e9ebef9ab28ab4e942a1c6415cebc08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac1edd764edccb7e6c240eed49bd073ae"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#gac1edd764edccb7e6c240eed49bd073ae">XMcdma_BdWrite64</a>(BaseAddress, Offset, Data)&#160;&#160;&#160;(*(u64 *)((UINTPTR)(void *)(BaseAddress) + (u32)(Offset))) = (u64)(Data)</td></tr>
<tr class="memdesc:gac1edd764edccb7e6c240eed49bd073ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write the given Buffer Descriptor double word.  <a href="group__mcdma.html#gac1edd764edccb7e6c240eed49bd073ae">More...</a><br/></td></tr>
<tr class="separator:gac1edd764edccb7e6c240eed49bd073ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga85e21c6be33fd36ffb9e559f53dfa2b4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga85e21c6be33fd36ffb9e559f53dfa2b4">XMcDma_BdGetSts</a>(BdPtr)&#160;&#160;&#160;<a class="el" href="group__mcdma.html#ga4a9c2fa82ee0b3c7518b7b9125a447e0">XMcdma_BdRead</a>((BdPtr), XMCDMA_BD_STS_OFFSET)</td></tr>
<tr class="memdesc:ga85e21c6be33fd36ffb9e559f53dfa2b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the status of a Ingress(S2MM) BD.  <a href="group__mcdma.html#ga85e21c6be33fd36ffb9e559f53dfa2b4">More...</a><br/></td></tr>
<tr class="separator:ga85e21c6be33fd36ffb9e559f53dfa2b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga369b7454a39ba87d032c2f40394360f8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga369b7454a39ba87d032c2f40394360f8">XMcdma_BdHwCompleted</a>(BdPtr)</td></tr>
<tr class="memdesc:ga369b7454a39ba87d032c2f40394360f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a Ingress(S2MM) BD has completed in hardware.  <a href="group__mcdma.html#ga369b7454a39ba87d032c2f40394360f8">More...</a><br/></td></tr>
<tr class="separator:ga369b7454a39ba87d032c2f40394360f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga884435b89a533b2195af16a29d41c5d2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga884435b89a533b2195af16a29d41c5d2">XMcDma_BdGetActualLength</a>(BdPtr, LengthMask)</td></tr>
<tr class="memdesc:ga884435b89a533b2195af16a29d41c5d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the actual transfer length of a Ingress (S2MM)BD.  <a href="group__mcdma.html#ga884435b89a533b2195af16a29d41c5d2">More...</a><br/></td></tr>
<tr class="separator:ga884435b89a533b2195af16a29d41c5d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga82a87f60a63faa72e95feea2d1af82a6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga82a87f60a63faa72e95feea2d1af82a6">XMcDma_TxBdGetSts</a>(BdPtr)&#160;&#160;&#160;<a class="el" href="group__mcdma.html#ga4a9c2fa82ee0b3c7518b7b9125a447e0">XMcdma_BdRead</a>((BdPtr), XMCDMA_BD_SIDEBAND_STS_OFFSET)</td></tr>
<tr class="memdesc:ga82a87f60a63faa72e95feea2d1af82a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the status of a Egress(MM2S) BD.  <a href="group__mcdma.html#ga82a87f60a63faa72e95feea2d1af82a6">More...</a><br/></td></tr>
<tr class="separator:ga82a87f60a63faa72e95feea2d1af82a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga659947c1fbe19d3ca1f0415af9850c15"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga659947c1fbe19d3ca1f0415af9850c15">XMcdma_TxBdHwCompleted</a>(BdPtr)</td></tr>
<tr class="memdesc:ga659947c1fbe19d3ca1f0415af9850c15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a Egress(MM2S) BD has completed in hardware.  <a href="group__mcdma.html#ga659947c1fbe19d3ca1f0415af9850c15">More...</a><br/></td></tr>
<tr class="separator:ga659947c1fbe19d3ca1f0415af9850c15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac3801a964c4a8acafc826d83fb54dcfc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#gac3801a964c4a8acafc826d83fb54dcfc">XMcDma_TxBdGetActualLength</a>(BdPtr, LengthMask)</td></tr>
<tr class="memdesc:gac3801a964c4a8acafc826d83fb54dcfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the actual transfer length of a Egress(MM2S) BD.  <a href="group__mcdma.html#gac3801a964c4a8acafc826d83fb54dcfc">More...</a><br/></td></tr>
<tr class="separator:gac3801a964c4a8acafc826d83fb54dcfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabe1a5cd6c2561c807261f7c9b8c4cd34"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#gabe1a5cd6c2561c807261f7c9b8c4cd34">XMcDma_BdGetCtrl</a>(BdPtr)</td></tr>
<tr class="memdesc:gabe1a5cd6c2561c807261f7c9b8c4cd34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the control bits of a BD.  <a href="group__mcdma.html#gabe1a5cd6c2561c807261f7c9b8c4cd34">More...</a><br/></td></tr>
<tr class="separator:gabe1a5cd6c2561c807261f7c9b8c4cd34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga66f21c01fc70df953e940e61d6fc133e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga66f21c01fc70df953e940e61d6fc133e">XMcdma_BdChainNextBd</a>(Chan, BdPtr)</td></tr>
<tr class="memdesc:ga66f21c01fc70df953e940e61d6fc133e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the next BD in the Chain.  <a href="group__mcdma.html#ga66f21c01fc70df953e940e61d6fc133e">More...</a><br/></td></tr>
<tr class="separator:ga66f21c01fc70df953e940e61d6fc133e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9bdd15b4246b9b6985c88fcac07ce432"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga9bdd15b4246b9b6985c88fcac07ce432">XMcdma_BdChainPrevBd</a>(Chan, BdPtr)</td></tr>
<tr class="memdesc:ga9bdd15b4246b9b6985c88fcac07ce432"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the previous BD in the Chain.  <a href="group__mcdma.html#ga9bdd15b4246b9b6985c88fcac07ce432">More...</a><br/></td></tr>
<tr class="separator:ga9bdd15b4246b9b6985c88fcac07ce432"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5fb0bfe1188cf10ace3f6788cb19f4d7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga5fb0bfe1188cf10ace3f6788cb19f4d7">XMcdma_HwIsStarted</a>(Chan)</td></tr>
<tr class="memdesc:ga5fb0bfe1188cf10ace3f6788cb19f4d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a DMA is started, meaning the channel is not halted.  <a href="group__mcdma.html#ga5fb0bfe1188cf10ace3f6788cb19f4d7">More...</a><br/></td></tr>
<tr class="separator:ga5fb0bfe1188cf10ace3f6788cb19f4d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga56bedd6346bb7deaefc4c46c98e02a8b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga56bedd6346bb7deaefc4c46c98e02a8b">XMcdma_ChanHwIsStarted</a>(Chan, Chan_id)</td></tr>
<tr class="memdesc:ga56bedd6346bb7deaefc4c46c98e02a8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a DMA channel is started, meaning the channel is not halted.  <a href="group__mcdma.html#ga56bedd6346bb7deaefc4c46c98e02a8b">More...</a><br/></td></tr>
<tr class="separator:ga56bedd6346bb7deaefc4c46c98e02a8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac8b57c02f29151129d0c5873d26bbda2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#gac8b57c02f29151129d0c5873d26bbda2">XMcDma_BdSetCtrlSideBand</a>(BdPtr, Tid, Tuser)</td></tr>
<tr class="memdesc:gac8b57c02f29151129d0c5873d26bbda2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the Tid and Tuser fields of a BD with the user provided values.  <a href="group__mcdma.html#gac8b57c02f29151129d0c5873d26bbda2">More...</a><br/></td></tr>
<tr class="separator:gac8b57c02f29151129d0c5873d26bbda2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1fdc6a4a27f6bd75aff05334be9060ce"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga1fdc6a4a27f6bd75aff05334be9060ce">XMcDma_GetBdSbandStats</a>(BdPtr)&#160;&#160;&#160;<a class="el" href="group__mcdma.html#ga4a9c2fa82ee0b3c7518b7b9125a447e0">XMcdma_BdRead</a>((BdPtr), XMCDMA_BD_SIDEBAND_STS_OFFSET)</td></tr>
<tr class="memdesc:ga1fdc6a4a27f6bd75aff05334be9060ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the side band status of a BD.  <a href="group__mcdma.html#ga1fdc6a4a27f6bd75aff05334be9060ce">More...</a><br/></td></tr>
<tr class="separator:ga1fdc6a4a27f6bd75aff05334be9060ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaed8f4b77eb238817267116c08caaa857"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#gaed8f4b77eb238817267116c08caaa857">XMcdma_BdClear</a>(BdPtr)</td></tr>
<tr class="memdesc:gaed8f4b77eb238817267116c08caaa857"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the BD Contents.  <a href="group__mcdma.html#gaed8f4b77eb238817267116c08caaa857">More...</a><br/></td></tr>
<tr class="separator:gaed8f4b77eb238817267116c08caaa857"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1b48d2e373be7642bbd1f48e7342f86e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga1b48d2e373be7642bbd1f48e7342f86e">XMcdma_BdSetSwId</a>(BdPtr, Id)&#160;&#160;&#160;(<a class="el" href="group__mcdma.html#ga2e9ebef9ab28ab4e942a1c6415cebc08">XMcdma_BdWrite</a>((BdPtr), XMCDMA_BD_SW_ID_OFFSET, (UINTPTR)(Id)))</td></tr>
<tr class="memdesc:ga1b48d2e373be7642bbd1f48e7342f86e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the Sw ID field of the given BD.  <a href="group__mcdma.html#ga1b48d2e373be7642bbd1f48e7342f86e">More...</a><br/></td></tr>
<tr class="separator:ga1b48d2e373be7642bbd1f48e7342f86e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea4638d00f6620f0a87e1816b53beaa6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#gaea4638d00f6620f0a87e1816b53beaa6">XMcdma_BdGetSwId</a>(BdPtr)&#160;&#160;&#160;(<a class="el" href="group__mcdma.html#ga4a9c2fa82ee0b3c7518b7b9125a447e0">XMcdma_BdRead</a>((BdPtr), XMCDMA_BD_SW_ID_OFFSET))</td></tr>
<tr class="memdesc:gaea4638d00f6620f0a87e1816b53beaa6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the Sw ID field of the given BD previously set with XMcdma_BdSetSwId.  <a href="group__mcdma.html#gaea4638d00f6620f0a87e1816b53beaa6">More...</a><br/></td></tr>
<tr class="separator:gaea4638d00f6620f0a87e1816b53beaa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
